Get Referral Program List

GET : http://<base_url>/digipay/v3/reward_promotion/referral_program

This api is used to assign bulk/internal products to the threshold of the agent and create a threshold detail

QUERY PARAMS:-

Parameter	Type	Description	Value
user_type	Int	integer value showing the user_type where user_type can be customer,agent and merchant	2
status	Int	Integer value showing the referral program status if value is 1 then referral program is active if value is 2 then referral program is inActive if vaule is 3 then referral program is expired	1
is_active	Boolean	if value is true it will show active languages in response, if value is false it will show inActive langauages in response	true/false
skip	Int	Skip the first n document from the query result	1
limit	Int	Limits the number of records or documents that you want	1
start_date	Long	a Unix timestamp value in second	1
end_date	Long	a Unix timestamp value in second	1
sorting	String	Sorting of the Data in the form of a string	123
search_keyword	String	a keyword which can be either name of language or a language code to get desired language as output	123

HEADERS:-

Parameter	Type	Description	Value
Authorization	String	It is a combination of type and token to authenticate user for the given token	Token duik7309njdlkhdauhknksadhjkas986876sd873j
CompanyID	String	Company_id is a unique primary id, that is represent company detail	76bc712200ca444fa334f9e55e5fd7a8

Request Body:-

Request Example

ccurl --request GET \
     --url 'http://192.168.1.102:8014/digipay/v3/reward_promotion/referral_program?user_type=2&status=2&is_active=false&skip=1&limit=2&start_date=1&end_date=1&sorting=123&search_keyword=123' \
     --header 'Authorization: Token duik7309njdlkhdauhknksadhjkas986876sd873j' \
     --header 'CompanyID: 7753ad6bd8cf48f5b1312fd21eb36588' \
     --header 'accept: application/json'

Response:-

Response 200(OK)

{
    "success": 1,
    "error": [],
    "data": {
        "referral_programs": [
            {
                "id": "4428647ee7ed420487cd6899f51eaa63",
                "referral_program_title": "Customer Program",
                "referfrom_rewards_type": 1,
                "referto_rewards_type": 1,
                "referral_for" : 1,
                "expiry_date": 160011245,
                "min_referrals": 1,
                "max_referrals": 10,
                "referral_reward_users": 1,
                "referral_condition" : {
                    "refer_type" : 1,
                    "refer" : { 
                        "referfrom_value":  0, 
                        "referfrom_value_type": 1, 
                        "referto_value": 0,
                        "referto_value_type": 1,
                    },  
                    "transaction" : { 
                        "referfrom_value": 0,
                        "referfrom_value_type":1,
                        "referto_value": 0,
                        "referto_value_type": 1,
                        "min_trans_amount":0,
                        "no_of_trans_required":0,
                    },
                },
                "status" : 1,
                "message": "Invite your friend to join Thawany app and You will get  10 $.",
                "currency_id": "123"
            }
        ]
    }
}     

Response 400(BAD REQUEST)

{
    "success": 0,
    "error"": [1],
    "data": {
        "message": "BAD_REQUEST",
     }
}

RESPONSES :-

Status Code	Description
200	OK
400	BAD REQUEST
404	NOT FOUND
500	INTERNAL SERVER ERROR